@types/tough-cookie

What is @types/tough-cookie?

The @types/tough-cookie package provides TypeScript type definitions for the tough-cookie library, which is a robust HTTP cookie parsing and serialization library. This package doesn't add any functionality on its own but allows developers using TypeScript to work with tough-cookie in a type-safe manner, offering autocompletion and type checking for the tough-cookie API.

What are @types/tough-cookie's main functionalities?

Cookie parsing

This feature allows for the parsing of a cookie string into a Cookie object, which can then be manipulated or inspected in a type-safe manner.

import { Cookie } from 'tough-cookie';

const cookie = Cookie.parse('key=value; expires=Fri, 31 Dec 9999 23:59:59 GMT;');

Cookie serialization

This feature enables the serialization of a Cookie object back into a string format, which can be used in HTTP headers.

import { Cookie } from 'tough-cookie';

const cookie = new Cookie({
  key: 'key',
  value: 'value',
  expires: new Date('9999-12-31T23:59:59.000Z')
});
const serializedCookie = cookie.toString();

Cookie jar management

This feature provides a way to manage a collection of cookies relevant to specific domains and paths, allowing for easy retrieval and storage of cookies across HTTP requests.

import { CookieJar } from 'tough-cookie';

const jar = new CookieJar();
jar.setCookieSync('key=value; Domain=example.com; Path=/;', 'http://example.com');
const cookies = jar.getCookiesSync('http://example.com');

Other packages similar to @types/tough-cookie

cookie

The cookie package is a simple, lightweight option for parsing and serializing cookies in Node.js and browser environments. It does not offer the same level of complexity or management capabilities (such as a cookie jar) as tough-cookie but is easier to use for basic tasks.

js-cookie

js-cookie is a simple, easy-to-use library for handling cookies in the browser. It provides a straightforward API for cookie manipulation, lacking the server-side capabilities and detailed configuration options of tough-cookie.

README

Installation

npm install --save @types/tough-cookie

Summary

This package contains type definitions for tough-cookie (https://github.com/salesforce/tough-cookie).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tough-cookie/v2.

Additional Details

• Last updated: Tue, 07 Nov 2023 20:08:00 GMT
• Dependencies: none

Credits

These definitions were written by Leonard Thieu, LiJinyao, and Michael Wei.